.TH MPE_CaptureFile 4 "6/15/2009" " " "MPE"
.SH NAME
MPE_CaptureFile \-  Sets the base filename used to capture output from updates 
.SH SYNOPSIS
.nf
#include "mpe.h" 
int MPE_CaptureFile( handle, fname, freq )
MPE_XGraph handle;
char       *fname;
int        freq;
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B handle 
- MPE graphics handle
.PD 1
.PD 0
.TP
.B fname  
- base file name (see below)
.PD 1
.PD 0
.TP
.B freq   
- Frequency of updates
.PD 1

.SH RETURN VALUES
.PD 0
.TP
.B MPE_ERR_LOW_MEM 
- malloc for copy of the filename (fname) failed
.PD 1
.PD 0
.TP
.B MPE_ERR_BAD_ARGS 
- 'handle' parameter is bad
.PD 1
.PD 0
.TP
.B MPE_SUCCESS 
- success
.PD 1

.SH NOTES
The output is written in xwd format to 'fname%d', where '%d' is the number
of the file (starting from zero).


.SH NOTES FOR FORTRAN INTERFACE 
The Fortran interface to this routine is different from its C
counterpart and it has an additional argument, ierr, at the end
of the argument list, i.e. the returned function value (the error
code) in C interface is returned as the additional argument in
Fortran interface.  The Fortran interface is invoked with the
CALL statement.

All MPI and MPE objects, MPI_Comm, MPE_XGraph and MPE_Color, are
of type INTEGER in Fortran.

.SH ADDITIONAL NOTES FOR FORTRAN INTERFACE 
The trailing blanks in Fortran 'CHARACTER' string argument will be
ignored.
.SH LOCATION
../src/graphics/src/mpe_graphics.c
